Improve API reliability #95

onmax · 2025-04-03T06:55:45Z

This PR introduces changes that improve reliability, simplify code, and keep it minimal.

Warning

Actions with schedule only run on main. Therefore I have created #101 to merge just the action.

Background

When we started to create the Validators API, we had to assume different scenarios and a lot of edge cases. We also lack of different external libraries (like @nimiq/utils/albatross-policy) which made the code complex and hard to maintain.

With the present PR we aim to remove the unused code, simplify code, and add more tools/UI elements to debug easier.

Breaking changes

Please, refer to the changelog.md to see list of breaking changes.

How the API works

The API itself still works the same, we have:

Fetcher: Retrieves information about ended epochs
The code has been untouched, as this worked perfectly.
Fetcher current epoch: Retrieves information about current epoch
This step before was unclear. Now, we have a proper system to retrieve data about the current epoch. We retrieve data for any kind of validator. Please read below "kind of validators"
Score computation
API endpoint to retrieve endpoints. The /api/v1/validators has minimal changes, where the rest of endpoints have been heavily modified. We have never documented them so I would say it ok, however I would like to ask the community for feedback.

Note

More information about how the project works internally in the README.md of this PR!

Kind of validators

Kind	Elected	Tracked
`ElectedTrackedValidator`	✅	✅
`ElectedUntrackedValidator`	✅	❌
`UnelectedTrackedValidator`	❌	✅
`UnelectedUntrackedValidator`	❌	❌

tracked: Weather the validator has submitted information in GitHub.

Note

Having a UnelectedUntrackedValidator should only be when the validator has been selected for the first time in history.

The big change is how we store the information in the DB.

Before we only stored activity for elected validators. This was prune to errors since it made the code quite complex because we needed to fill in the missing data from the database at runtime.

Now, we have shifted and we store one activity per epoch per validator. The unelected validators will have missed: -1, rewarded: -1, dominanceViaSlots: -1 and likelihood: -1. The rest of fields will be filled: balance, dominanceViaBalance, stakers (new field).

Warning

We should create a system for deleted validators and stop tracking those. This is part of future work.

Range

The range is composed by the following fields:

fromXXX: The information for the first block/epoch we consider (~9 months). We have: fromEpoch, fromBlockNumber, fromTimestamp
toXXX: The information for the last block/epoch we consider. We have: toEpoch, toBlockNumber, toTimestamp
snapshotXXX: The information for current epoch. (It is not called currentEpoch as this could be missleading when talking about a range that is in the past). We have: snapshotEpoch, snapshotBlockNumber, snapshotTimestamp. If you have a better name, please suggest it.

Import JSON validators information

Cloudflare cannot access to the filesystem. Therefore, this PR also introduces a new mechanism to fetch the validators using ungh api.

Monorepo

This PR also simplifies monorepo configuration, having a catalog of dependencies, dev-related dependencies only in the top level (eslint, vitest, scripts), among other changes...

Out of scope

Please check out the issues tab to see which new issues will NOT be addressed in this PR

This PR closes the following issues

…f their status in the network - We know categorize validators as active or inactive

now everything is run in the root to avoid duplicating configs

…e function

…elete conflicting workflow files

onmax · 2025-05-02T08:51:40Z

Conflicts resolved, and action successfully running.

Ready for merging

Copilot

Pull Request Overview

This PR improves API reliability by simplifying components, updating sync and status logic in the main application file, and enhancing documentation and CI/CD workflows.

Updated Identicon component to use an identicon library and simplified its props.
Removed the unused Donut component.
Introduced improved status, sync, and environment display logic in app/app.vue.
Updated README, CHANGELOG, and GitHub workflows for consistency and clarity.

Reviewed Changes

Copilot reviewed 142 out of 155 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
app/components/Identicon.vue	Switched to using createIdenticon and updated prop definitions.
app/components/Donut.client.vue	Removed unused component logic.
app/app.vue	Added status fetch, SSE sync logic, and environment UI enhancements.
README.md	Updated documentation with improved visuals and corrected typos.
CHANGELOG.md	Documented breaking changes and new features.
.github/workflows/nuxt-hub.yml	Added deployment workflow for NuxtHub environments.
.github/workflows/ci.yml	Updated CI workflow with recent Node and dependency settings.

Files not reviewed (13)

.env.example: Language not supported
.github/workflows/import-validators-mainnet.yml: Language not supported
.github/workflows/import-validators-testnet.yml: Language not supported
.github/workflows/import-validators.yml: Language not supported
.github/workflows/nuxthub-validators-api-mainnet.yml: Language not supported
.github/workflows/nuxthub-validators-api-testnet.yml: Language not supported
.github/workflows/pkg.new.yml: Language not supported
.github/workflows/release.yml: Language not supported
.github/workflows/sync-mainnet.yml: Language not supported
.github/workflows/sync-testnet.yml: Language not supported
.github/workflows/sync.yml: Language not supported
.release-it.json: Language not supported
.vscode/settings.json: Language not supported

Copilot · 2025-05-02T08:53:03Z

app/components/Identicon.vue

-    return 'data:image/svg+xml,<svg width="64" height="64" viewBox="0 -4 64 64" fill="none" xmlns="http://www.w3.org/2000/svg"><path opacity=".1" d="M62.3 25.4L49.2 2.6A5.3 5.3 0 0 0 44.6 0H18.4c-1.9 0-3.6 1-4.6 2.6L.7 25.4c-1 1.6-1 3.6 0 5.2l13.1 22.8c1 1.6 2.7 2.6 4.6 2.6h26.2c1.9 0 3.6-1 4.6-2.6l13-22.8c1-1.6 1-3.6.1-5.2z" fill="url(%23identicon_radial)"/><defs><radialGradient id="identicon_radial" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-63.0033 0 0 -56 63 56)"><stop stop-color="%23260133"/><stop offset="1" stop-color="%231F2348"/></radialGradient></defs></svg>'
-  return props.validator.logo
-})
+const { address, logo: _logo, name } = defineProps<{ logo?: string | undefined, address: string, name: string }>()


[nitpick] Consider extracting the props type into a separate interface or type alias to enhance readability and ease future maintenance.

Suggested change

const { address, logo: _logo, name } = defineProps<{ logo?: string | undefined, address: string, name: string }>()

type IdenticonProps = { logo?: string | undefined, address: string, name: string }

const { address, logo: _logo, name } = defineProps<IdenticonProps>()

Copilot · 2025-05-02T08:53:04Z

app/app.vue

+}, { immediate: true })
+
+// Also maintain the original watch for general updates
+watch(() => [dataSync, syncError], debouncedRefresh)


[nitpick] Consider listing the reactive dependencies individually instead of wrapping them in an array to ensure clear reactivity tracking.

Suggested change

watch(() => [dataSync, syncError], debouncedRefresh)

watch([dataSync, syncError], debouncedRefresh)

onmax and others added 30 commits December 23, 2024 20:40

fix: exclude entries with balance equal to 1 in epoch number query

cd05c7d

chore: fix JSON format

c18bc98

chore: disable corepack

aee5e02

chore: update github actions

d063597

feat: include staked balance in reason object

a23d252

Merge branch 'main' into dev

e9096e4

Merge branch 'main' into dev

0e208e3

chore: updated rpc client version

a66c066

feat: retrieve validators balances for any validators independently o…

3bedc68

…f their status in the network - We know categorize validators as active or inactive

chore: return error if there is no connection to RPC node

e8c410a

chore!: removed only-active query param in /validators

f0d8b9d

refactor: validators score endpoint

a23454c

Add Siam Testnet Pool

98f2683

refactor: simplify validators endpoint

6aca76e

chore: remove moved packages to @nimiq/utils

adeaa4e

Merge branch 'dev' of https://github.com/nimiq/validators-api into dev

fc4da6c

chore: remove eslint from the package

65871b1

chore: updated eslint and run formatter

d1aa526

chore: removed radix

8f2a0dc

chore: fixing build

deb5cf2

chore: general cleanup

1c5f146

chore: remove package ci.

ca09044

now everything is run in the root to avoid duplicating configs

feat!: return ResultSync type

bb89c51

feat!: removed remote getPolicyConstant request

7db4a7d

feat!: use Result type everywhere

bdbb99f

chore!: removed most endpoints and leave sync endpoint

f677196

chore!: updated workflows

2c4277e

chore: added nuxthub action

7a94043

chore: migrated to '@nimiq/utils/albatross-policy'

60fdbb7

chore: more clean up. removed unused functions

2f43fb1

onmax deployed to preview-mainnet May 2, 2025 08:10 — with GitHub Actions View deployment

feat: add error handling for missing dominance ratio in calculateScor…

30c053f

…e function

onmax deployed to preview-testnet May 2, 2025 08:17 — with GitHub Actions View deployment

onmax had a problem deploying to preview-mainnet May 2, 2025 08:17 — with GitHub Actions Failure

onmax temporarily deployed to preview-testnet May 2, 2025 08:17 — with GitHub Actions Inactive

onmax deployed to preview-mainnet May 2, 2025 08:19 — with GitHub Actions View deployment

feat: return 0 for missing dominance ratio in calculateScore function

2960a38

onmax temporarily deployed to preview-testnet May 2, 2025 08:25 — with GitHub Actions Inactive

onmax deployed to preview-testnet May 2, 2025 08:25 — with GitHub Actions View deployment

onmax deployed to preview-mainnet May 2, 2025 08:25 — with GitHub Actions View deployment

chore: dominanceRatio can be 0

0a2ec25

onmax deployed to preview-mainnet May 2, 2025 08:31 — with GitHub Actions View deployment

onmax deployed to preview-testnet May 2, 2025 08:31 — with GitHub Actions View deployment

onmax temporarily deployed to preview-testnet May 2, 2025 08:31 — with GitHub Actions Inactive

docs: improved readme

875cae5

onmax deployed to preview-mainnet May 2, 2025 08:43 — with GitHub Actions View deployment

onmax deployed to preview-testnet May 2, 2025 08:43 — with GitHub Actions View deployment

onmax temporarily deployed to preview-testnet May 2, 2025 08:43 — with GitHub Actions Inactive

docs: update API endpoint in

b711eb6

onmax temporarily deployed to preview-testnet May 2, 2025 08:45 — with GitHub Actions Inactive

onmax deployed to preview-mainnet May 2, 2025 08:45 — with GitHub Actions View deployment

onmax deployed to preview-testnet May 2, 2025 08:45 — with GitHub Actions View deployment

Merge main into dev with resolved conflicts: keep sync-matrix.yaml, d…

ebbf82a

…elete conflicting workflow files

onmax deployed to preview-testnet May 2, 2025 08:50 — with GitHub Actions View deployment

onmax deployed to preview-mainnet May 2, 2025 08:50 — with GitHub Actions View deployment

onmax temporarily deployed to preview-testnet May 2, 2025 08:50 — with GitHub Actions Inactive

onmax requested review from Albermonte and Copilot May 2, 2025 08:52

Copilot AI reviewed May 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve API reliability #95

Improve API reliability #95

onmax commented Apr 3, 2025 •

edited

Loading

onmax commented May 2, 2025

Copilot AI left a comment

Copilot AI May 2, 2025

Copilot AI May 2, 2025

	const { address, logo: _logo, name } = defineProps<{ logo?: string \| undefined, address: string, name: string }>()
	type IdenticonProps = { logo?: string \| undefined, address: string, name: string }
	const { address, logo: _logo, name } = defineProps<IdenticonProps>()

	watch(() => [dataSync, syncError], debouncedRefresh)
	watch([dataSync, syncError], debouncedRefresh)

Improve API reliability #95

Are you sure you want to change the base?

Improve API reliability #95

Conversation

onmax commented Apr 3, 2025 • edited Loading

Background

Breaking changes

How the API works

Kind of validators

Range

Import JSON validators information

Monorepo

Out of scope

This PR closes the following issues

onmax commented May 2, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Copilot AI May 2, 2025

Choose a reason for hiding this comment

Copilot AI May 2, 2025

Choose a reason for hiding this comment

onmax commented Apr 3, 2025 •

edited

Loading